Tags

[POST] /api/v2/common/tags/{tagId}/documents

查询与特定标签相关的文档并对结果进行分页。

参数:

名称	类型	位置	描述
tagId必填项	string	path	用于过滤文档的标签的唯一标识符。预期格式：UUID。示例：ab8dc626-2d0a-4a58-908a-35ad7ab30422

This method handles pagination based on the parameters provided in the model.
It filters documents by the specified tagId and applies additional filters and sorting as specified in the model.

请求数据格式

DocumentTagPaginationRequestModel

返回值

状态码: 200

成功

DocumentPaginationResponseModel

状态码: 400

错误的请求

ServerPluginError

[GET] /api/v2/common/tags

根据各种过滤器检索有关标签的信息。

参数:

名称	类型	位置	描述
tagId	string	query	标签的唯一标识符。用于过滤结果以仅包含此标签。示例：“12345”
names	string	query	以逗号分隔的标签名称列表。用于过滤结果以仅包含这些名称。示例：“Tag1,Tag2”
name	string	query	单个标签名称。用于过滤结果以仅包含此名称。示例：“Tag3”
filterByType	string	query	根据文档类型应用的过滤器。示例：“DocumentType”
disableHideInDocumentPortalFilter	Boolean	query	标记以禁用隐藏文档门户中文档的过滤器。示例：false
isFromExportPage	Boolean	query	标记，指示查询是否来自导出页面。示例：true
needDocumentCount	Boolean	query	标记指示是否在响应中包含与每个标签相关的文档数。示例：true
type	string	query	查询的标签类型。默认为“全部”。示例：“custom”

返回值

状态码: 200

成功

TagResponseListModel

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/common/tags

根据提供的标签详细信息向系统添加新标签。此操作会创建具有指定属性（包括名称、顺序和权限）的标签。

请求数据格式

TagsRequestModel

返回值

状态码: 200

成功

AddTagResponseModel

状态码: 400

错误的请求

ServerPluginError

[PUT] /api/v2/common/tags/{tagId}

更新由 tagId 标识的现有标签的详细信息。

参数:

名称	类型	位置	描述
tagId必填项	string	path	要更新的标签的唯一标识符。预期格式：UUID。示例：ab8dc626-2d0a-4a58-908a-35ad7ab30422

请求数据格式

TagsRequestModel

返回值

状态码: 200

成功

UpdateTagResponseModel

状态码: 400

错误的请求

ServerPluginError

[DELETE] /api/v2/common/tags/{tagId}

根据提供的标签 ID 从系统中删除标签。

参数:

名称	类型	位置	描述
tagId必填项	string	path	要删除的标签的唯一标识符。预期格式：UUID。示例：ab8dc626-2d0a-4a58-908a-35ad7ab30422

返回值

状态码: 200

成功

Array<string>

状态码: 400

错误的请求

ServerPluginError

[POST] /api/v2/common/tags/move

将标签从一个父标签移动到另一个父标签或更改其在标签结构中的层次结构。

请求数据格式

MoveTagRequestModel

返回值

状态码: 200

成功

Array<string>

状态码: 400

错误的请求

ServerPluginError

类型定义

Ƭ DocumentPaginationResponseModel

表示分页文档查询的响应模型。

名称	类型	描述	示例
pagination	PaginationModel
data可为空	DocumentVO	表示当前文档页面的文档视图对象 (VO) 的只读列表。每个 DocumentVO 都包含文档元数据以及显示或处理所需的任何其他信息。

Ƭ PaginationModel

表示返回项目列表的查询的分页信息。此模型用于通过指定每页的大小和当前页码来管理大型数据集的分页。

名称	类型	描述
pageSize	int32	获取或设置单页上显示的项目数。
pageNumber	int32	获取或设置当前页码。
total	int64	获取或设置所有页面上的项目总数。

Ƭ DocumentVO

表示文档的视图对象，封装各种元数据和状态信息。

名称	类型	描述
created可为空	ISO DateTime Sting	文档的创建时间戳。
deleted可为空	ISO DateTime Sting	如果已删除，则显示文档的删除时间戳。
modified可为空	ISO DateTime Sting	文档的最后修改时间戳。
createdBy	SampleUserResponseModel
modifiedBy	SampleUserResponseModel
deletedBy	SampleUserResponseModel
description可为空	string	该文件的简要描述。
displayName可为空	string	文档的显示名称。
ext可为空	string	文档的文件扩展名。
hideInDocumentPortal	Boolean	指示文档是否在文档门户中隐藏。
hideOnMobile	Boolean	指示文档在移动设备上是否隐藏。
id可为空	string	文档的唯一标识符。
isResource	Boolean	指示该文档是否是资源。
meta可为空	string	与文档相关的元数据。
organizationId可为空	string	与文档关联的组织 ID。
organizationIdPath可为空	string	与文档关联的组织 ID 的路径。
thumbnail可为空	string	文档缩略图的 URL。
title可为空	string	文档的标题。
type可为空	string	文档的类型。
customPermissions可为空	`Array<string>`	与文档相关的自定义权限。
contentUrl可为空	string	访问文档内容的 URL。
revisionNo	int32	文档的修订号。
revisionContentUrl可为空	string	访问特定文档修订内容的 URL。
isSystemReserved	Boolean	表示该文件是否被系统保留。
effectiveOps可为空	string	允许对该文档进行有效的操作。
security	SecurityResponseModel
references可为空	ReferenceResponseModel	与文档相关的参考文献。
revisions可为空	RevisionResponseModel	文档的修订历史。
tags可为空	TagResponseInfoModel	与文档相关的标签。

Ƭ SampleUserResponseModel

表示用户的简化模型，提供各种响应模型中使用的基本信息。

名称	类型	描述	示例
id可为空	string	用户的唯一标识符。
name可为空	string	用户的名称。

Ƭ SecurityResponseModel

文档的安全设置。

名称	类型	描述	示例
ownerId可为空	string	所有者的唯一标识符。
permissions可为空	AclEntryQueryModel	文档访问权限。

Ƭ ReferenceResponseModel

表示文档引用的模型，包括有关文档及其权限的详细信息。

名称	类型	描述
documentId可为空	string	引用文档的唯一标识符。
resourceName可为空	string	与该文档关联的资源的名称。
resourceDocType可为空	string	资源文档的类型。
resourceDocName可为空	string	资源文档的名称。
displayName可为空	string	供参考的显示名称。
meta可为空	string	与文档相关的元数据。
documentRev可为空	string	文件的修订。
isDirectChild	Boolean	指示该文档是否是父文档的直接子文档。
permission可为空	string	文档的权限级别。
contentUrl可为空	string	访问文档内容的 URL。
minimalPermission可为空	string	访问文档所需的最低权限。

Ƭ RevisionResponseModel

表示文档修订的模型，包括修订号、注释、元数据和相关用户信息等详细信息。

名称	类型	描述
no	int32	修订号。这通常是一个整数，随着每个新修订而递增。
comment可为空	string	描述本次修订所做更改的评论。
meta可为空	string	与修订相关的元数据，可能包括标签或关键字等详细信息。
createdBy	SampleUserResponseModel
created可为空	ISO DateTime Sting	此修订的创建日期和时间。
modifiedBy	SampleUserResponseModel
modified可为空	ISO DateTime Sting	上次修改此修订的日期和时间。
contentUrl可为空	string	访问此修订内容的 URL。
references可为空	ReferenceResponseModel	与此次修订相关的参考列表，例如相关文档或资源。

Ƭ TagResponseInfoModel

表示标签的响应模型，包括其元数据和状态。

名称	类型	描述
id可为空	string	标签的唯一标识符。
parentId可为空	string	父标签的唯一标识符（如果有）。
realName可为空	string	标签的显示名称。
order	int32	标签在其兄弟标签中的显示顺序。
url可为空	string	与标签关联的 URL，通常用于导航。
iconCssClass可为空	string	标签图标的 CSS 类，用于视觉呈现。
color可为空	string	与标签相关的颜色，用于视觉呈现。
isFavorites	Boolean	指示标签是否被标记为收藏。
isPersonal	Boolean	指示标签是否属于用户个人。
orgId可为空	string	与标签关联的组织的唯一标识符。
documentCount	int32	与标签关联的文档的数量。
name可为空	string	用于识别和搜索的标签名称。

Ƭ AclEntryQueryModel

为子角色定义 ACL 条目权限。

名称	类型	描述
sub	RoleResponseModel
ops可为空	`Array<string>`	授權操作。
opflags	int32	用于额外控制的操作标志。

Ƭ RoleResponseModel

代表系统内的角色。

名称	类型	描述
id可为空	string	角色的唯一标识符。
name可为空	string	角色的名称。
type可为空	string	角色的类型。

Ƭ ServerPluginError

服务器插件错误

名称	类型	描述
code可为空	string	错误代码
message可为空	string	错误信息
context可为空	string	错误上下文
innerError	ServerPluginError

Ƭ DocumentTagPaginationRequestModel

文档分页请求模型

名称	类型	描述	示例
documentId可为空	string	获取或设置文档 ID。	`"e3808c7e-c0e7-44da-96a2-200b3bb216c6"`
pageSize	int32	获取或设置每页显示的文档数。	`10`
pageNumber	int32	获取或设置要显示的页码。	`1`
orderBy可为空	string	获取或设置用于对文档进行排序的字段。	`"creationDate"`
disableHideInDocumentPortalFilter	Boolean	获取或设置一个值，指示是否禁用文档门户过滤器中的隐藏。
filterByType可为空	string	获取或设置要筛选的文档类型。	`"report"`
isFromExportPage	Boolean	获取或设置一个值，指示查询是否来自导出页面。
search可为空	string	获取或设置文档标题的搜索关键字。	`"annual report"`
createdTimeRange可为空	`Array<string>`	获取或设置文档的创建时间范围。
modifiedTimeRange可为空	`Array<string>`	获取或设置文档的修改时间范围。
creator可为空	string	获取或设置文档的创建者。	`"John Doe"`
modifier可为空	string	获取或设置文档的修饰符。	`"Jane Smith"`
lng可为空	string	获取或设置语言代码。	`"en-US"`
extendQuery	ExtendQuery
includeIndirectReference	Boolean	获取或设置是否包含间接引用文档。仅当extendQuery所代表的含义包含Reference时，该配置才生效。	`true`

Ƭ ExtendQuery

Enum:

None
EffectiveOps
Security
References
Revisions
Tags
All

定义使用附加信息扩展文档查询的选项。

此枚举允许指定应在文档查询响应中包含哪些附加数据。
它支持按位运算来组合多个选项。

* None - 0 - 不包含任何附加数据。
* EffectiveOps - 1 - 包含适用于文档的有效操作。
* Security - 2 - 包含安全信息，如访问控制列表。
* References - 4 - 包含对其他文档的引用。
* Revisions - 8 - 包含有关文档修订的信息。
* Tags - 16 - 包含与文档关联的标签。
* All - 31 - 包含所有可用的扩展信息。

Ƭ TagResponseListModel

名称	类型	描述	示例
tagsInfo可为空	TagResponseInfoModel

Ƭ AddTagResponseModel

表示添加标签的响应模型，包含新添加的标签的唯一标识符。

名称	类型	描述	示例
tagId可为空	string	已添加标签的唯一标识符。

Ƭ TagsRequestModel

表示创建或更新标签的请求模型，包括名称、顺序、权限等详细信息。

名称	类型	描述	示例
name可为空	string	获取标签的名称。	`"sales"`
urlName可为空	string	获取标签的 URL 友好名称。	`"sales"`
order可为空	int32	获取标签在其层次结构或列表中的显示顺序。	`301266`
organizationId可为空	string	获取标签所属组织的唯一标识符。	`"63191df0-9464-4cf7-8d4b-07a63208d209"`
isPersonal	Boolean	指示标签是否属于用户个人。
parentId可为空	string	获取父标签的唯一标识符（如果有）。	`"6825c89e-2a9b-494c-8e98-3d21bacd79fb"`
color可为空	string	获取与标签相关的颜色。	`"#FF5733"`
iconCssClass可为空	string	获取标签图标的 CSS 类。	`"mdi mdi-account"`
grant可为空	AccessEntryDto	获取授予标签的访问权限列表。

Ƭ AccessEntryDto

访问条目 Dto

名称	类型	描述	示例
role可为空	string	角色名称
ops可为空	Operations	运营

Ƭ Operations

Enum:

None
Create
Read
Update
Delete
Modify
ChangePermission
Execute
FullControl
All

Ƭ UpdateTagResponseModel

表示更新标签的响应模型，包含已更新标签的唯一标识符。

名称	类型	描述	示例
tagId可为空	string	已更新的标签的唯一标识符。

Ƭ MoveTagRequestModel

表示将标签从一个父级移动到另一个父级或在层次结构中更改其位置的请求模型。

名称	类型	描述	示例
fromTagId可为空	string	获取正在移动的标签的唯一标识符。	`"fromTag123"`
toTagId可为空	string	获取目标标签的唯一标识符。	`"toTag456"`
updateParent	Boolean	指示是否应在移动操作中更新父标签。	`true`
toParentTagId可为空	string	如果父标签正在更新，则获取新父标签的唯一标识符。	`"newParent789"`